package com.iszhangsc.backup.common;

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * <p>
 * 服务端接口统一返回封装对象
 * </p>
 *
 * @author zhangshichang
 * @date 2020-12-20 13:52
 */
@Data
public final class ResultVO<T> {

    /**
     * 状态码<br/>
     * 200-请求成功<br/>
     * 400-请求失败<br/>
     * 500-服务器内部错误<br/>
     */
    @ApiModelProperty(name = "code", value = "code: 200->请求成功, 400->请求失败:一般为参数格式错误, 500->服务器错误", position = 1, example = "200")
    private Integer code;

    /**
     * 返回成功或者失败的消息
     */
    @ApiModelProperty(name = "msg", value = "提示信息", position = 2, example = "success")
    private String msg;

    /**
     * JSON数据
     */
    @ApiModelProperty(name = "data", value = "具体数据", position = 3)
    private T data;


    /**
     * 无数据返回,没有数据返回时默认使用该属性
     */
    @SuppressWarnings("rawtypes")
    private static final ResultVO NOT_DATA = new ResultVO<>(200, "success");

    private ResultVO() {

    }


    /**
     * 有数据构造函数
     *
     * @param code 状态码
     * @param msg  消息
     * @param data JSON数据
     */
    public ResultVO(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    /**
     * 无数据构造函数
     *
     * @param code 状态码
     * @param msg  消息
     */
    public ResultVO(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }



    /**
     * 成功时无数据返回调用,常用于新增、修改、删除等接口.
     *
     * @return ResultVO
     */
    @SuppressWarnings("rawtypes")
    public static ResultVO ok() {
        return ResultVO.NOT_DATA;
    }

    /**
     * 成功时有数据返回调用,常用于查询返回.
     *
     * @return ResultVO
     */
    public static <T> ResultVO<T> ok(T data) {
        return new ResultVO<>( 200, "success", data);
    }

    /**
     * 失败时调用，并返回提示信息,默认状态码为400
     *
     * @param msg 提示信息
     * @return  ResultVO
     */
    public static <T> ResultVO<T> fail(String msg) {
        return new ResultVO<>(400, msg);
    }

    /**
     * 失败时调用，自定义状态码并返回提示信息
     *
     * @param code 状态码
     * @param msg  提示信息
     * @return  ResultVO
     */
    public static <T> ResultVO<T> fail(int code, String msg) {
        return new ResultVO<>(code, msg);
    }


}
